Developer CD Series 1996 January: Mac OS SDK

home *** CD-ROM | disk | FTP | other *** search

/ Developer CD Series 1996 January: Mac OS SDK / Dev.CD Jan 96 SDK / Dev.CD Jan 96 SDK1.toast / Development Kits (Disc 1) / OpenTransport / Open Transport 1.0.5b4 / Open Transport SDK / Open Tpt Module Developer / Includes / OpenTptModule.h < prev next >

Wrap

C/C++ Source or Header | 1995-06-24 | 25.1 KB | 905 lines | [TEXT/MPS ]

/* File: OpenTptModule.h Contains: headers for STREAM modules developement Copyright: © 1993-1995 by Apple Computer, Inc. and Mentat Inc., all rights reserved. */ #ifndef __OPENTPTMODULE__ #define __OPENTPTMODULE__ #define OTKERNEL 1 #ifndef __OPENTRANSPORT__ #include <OpenTransport.h> #endif /* * Some typedefs needed to include cred.h and mistream.h */ typedef UInt32 uint; // this line deleted from release disk typedef UInt16 ushort; // this line deleted from release disk typedef UInt32 ulong; // this line deleted from release disk typedef UInt32 uid_t; typedef UInt32 gid_t; typedef UInt32 dev_t; #ifndef _CRED_ #include <cred.h> #endif #ifndef __OPENTPTDEV__ #include <OpenTptDev.h> #endif #ifndef _STRLOG_ #include <strlog.h> #endif #ifndef __MEMORY__ #include <Memory.h> #endif #if defined(__MWERKS__) && GENERATING68K #pragma pointers_in_D0 #endif /******************************************************************************* ** Some IOCTL constants modules need to know ********************************************************************************/ #define I_LINK MIOC_CMD(MIOC_STREAMIO,12) /* connect stream under mux fd */ #define I_UNLINK MIOC_CMD(MIOC_STREAMIO,13) /* disconnect two streams */ #define I_PLINK MIOC_CMD(MIOC_STREAMIO,29) /* permanently connect a stream under a mux */ #define I_PUNLINK MIOC_CMD(MIOC_STREAMIO,30) /* disconnect a permanent link */ /******************************************************************************* ** Printing functions ********************************************************************************/ enum { kOTPrintOnly = 0, kOTPrintThenStop = 1 }; #ifdef __cplusplus extern "C" { #endif int OTKernelPrintf(int toDo, char* fmt, ...); #ifdef __cplusplus } #endif /******************************************************************************* ** Function to convert the "long" value that comes back in some of the ** netbufs as a result code to the equivalent OSStatus ********************************************************************************/ typedef long OTError; #define GetEError(v) ((OTUnixErr)(((v) >> 16) & 0xffff)) #define GetXTIError(v) ((OTXTIErr)((v) & 0xffff)) #define MakeEError(e) ((OTError)(((((UInt32)(e)) << 16) | TSYSERR))) #define MakeXTIError(xti) ((OTError)(xti)) #ifdef __cplusplus extern "C" { #endif OSStatus OTErrorToOSStatus(OTError); #ifdef __cplusplus } #endif /******************************************************************************* ** Things need to be able to export a module ********************************************************************************/ /* ------------------------------------------------------------------------- Synchronization level codes. These are supplied to modsw_install and stored in the appropriate tables. sth_osr_open and sth_ipush use these to set up synch queue subordination for new devices and modules. ------------------------------------------------------------------------- */ enum { SQLVL_QUEUE = 1, SQLVL_QUEUEPAIR = 2, SQLVL_MODULE = 3, SQLVL_GLOBAL = 4, SQLVL_DEFAULT = SQLVL_MODULE }; /* ------------------------------------------------------------------------- The install_info structure. ------------------------------------------------------------------------- */ struct install_info { struct streamtab* install_str; /* Streamtab pointer. */ UInt32 install_flags; UInt32 install_sqlvl; /* Synchronization level. */ char* install_buddy; /* Shared writer list buddy */ long ref_load; /* Set to 0 */ UInt32 ref_count; /* set to 0 */ }; typedef struct install_info install_info; // // Flags used in the install_flags field // enum { kOTModIsDriver = 0x00000001, kOTModIsModule = 0x00000002, kOTModUpperIsTPI = 0x00001000, kOTModUpperIsDLPI = 0x00002000, kOTModLowerIsTPI = 0x00004000, kOTModLowerIsDLPI = 0x00008000, // // These flags are only valid if kOTModIsDriver is set. // kOTModIsLowerMux = 0x10000000, kOTModIsComplexDriver = 0x20000000, // // These flags are only valid if kOTModIsModule is set. // kOTModIsFilter = 0x40000000, kOTModPushAlways = 0x80000000 }; /* ------------------------------------------------------------------------- Typedef for the GetOTInstallInfo function Your module must export this function, and return a pointer to the install_info structure for the module. ------------------------------------------------------------------------- */ typedef install_info* (* _CDECL GetOTInstallInfoProcPtr)(void); /* ------------------------------------------------------------------------- Typedef for the InitStreamModule function Your module can optionally export this function. It will be called whenever your module is about to be loaded into a stream for the first time, or if it is about to be reloaded after having been unloaded. Return false if your module should NOT be loaded. For STREAMS modules, the void* parameter will be NULL. For drivers, it will be the same cookie parameter that was used for registering the module. For PCI card drivers, this will be a pointer to the OTPCIInfo structure, which can also be interpreted as a RegEntryIDPtr. ------------------------------------------------------------------------- */ typedef Boolean (* _CDECL InitStreamModuleProcPtr)(void*); /* ------------------------------------------------------------------------- Typedef for the TerminateStreamModule function Your module can optionally export this function. It will be called whenever your module has been closed for the last time (i.e. no other outstanding instances of the module exist). ------------------------------------------------------------------------- */ typedef void (* _CDECL TerminateStreamModuleProcPtr)(void*); /******************************************************************************* ** Equates for shared library prefixes ********************************************************************************/ /* * Prefixes for Open Transport driver experts. */ #define kOTPortScannerPrefix "ot:pScnr$" /* * Interface ID for "C" STREAMS Modules for ASLM */ #define kOTModuleInterfaceID kOTModulePrefix "CStrmMod" /******************************************************************************* ** Functions for dealing with major and minor device numbers ********************************************************************************/ typedef UInt16 major_t; typedef UInt16 minor_t; /* major part of a device */ #define getmajor(x) ((major_t)(((unsigned long)(x)>>16)&0xffff)) /* minor part of a device */ #define getminor(x) ((minor_t)((x)&0xffff)) /* make a device number */ #define makedev(x,y) ((dev_t)((((dev_t)(x))<<16) | ((y) & 0xffff))) #define getemajor getmajor #define geteminor getminor #define makedevice makedev #define etoimajor(majnum) (majnum) #define itoemajor(majnum,j) (majnum) /******************************************************************************* ** Some definitions ********************************************************************************/ /* * The first minor number that you should use for CLONEOPENs. * Minor numbers 0 through 9 are reserved for use by the modules * for various control streams. */ enum { kFirstMinorNumber = 10 }; /* * Extra OTCommand codes that may appear on your module queue. * These are extensions to the TPI specification for Open Transport. * T_PRIVATE_REQ is the first available TPI message number for private * use by modules (assuming you don't want to be confused by standard * TPI messages). */ enum { T_TIMER_REQ = 80, // Timer event T_MIB_REQ = 81, // Request module's MIB T_MIB_ACK = 82, // The module's MIB is available T_PRIVATE_REQ = 90 // The first private request available }; /******************************************************************************* ** Logging Macros ********************************************************************************/ #ifdef __cplusplus extern "C" { #endif void OTStrlog(queue_t*, int, int, const char*); #ifdef __cplusplus } #endif // // These are enums for the level value // enum { kOTBug = 0, // Use this for a bug in OT kOTClientBug = 1, // Use this for a client bug (client did bad thing!) kOTUnrecoverableProblem = 2, kOTRecoverableProblem = 3, kOTPacketProblem = 4, kOTInfoMessage = 5 }; #define STRLOG(q, lvl, flags, str) OTStrlog(q, lvl, flags, str) #if qDebug #define STRLOG1(q, lvl, flags, str) OTStrlog(q, lvl, flags, str) #else #define STRLOG1(q, lvl, flags, str) #endif #if qDebug > 1 #define STRLOG2(q, lvl, flags, str) OTStrlog(q, lvl, flags, str) #else #define STRLOG2(q, lvl, flags, str) #endif #if qDebug > 2 #define STRLOG3(q, lvl, flags, str) OTStrlog(q, lvl, flags, str) #else #define STRLOG3(q, lvl, flags, str) #endif /******************************************************************************* ** Structure definitions ** ** These go along with the extra definitions above. ********************************************************************************/ struct T_MIB_req { long PRIM_type; /* Always T_MIB_REQ */ }; struct T_MIB_ack { long PRIM_type; /* Always T_MIB_ACK */ long MIB_length; /* MIB length */ long MIB_offset; /* MIB Offset */ }; struct T_stream_timer { long PRIM_type; /* Always T_TIMER_REQ */ union { long USER_long; void* USER_ptr; #ifndef __cplusplus } USER_data; #else }; #endif }; /* ------------------------------------------------------------------------- Internal port record structures ------------------------------------------------------------------------- */ /* * One TPortRecord is created for each instance of a port. * For Instance 'enet' identifies an ethernet port. * An TPortRecord for each ethernet card it finds, with an * OTPortRef that will uniquely allow the ethernet driver to determine which * port it is supposed to open on. */ typedef struct TPortRecord TPortRecord; struct TPortRecord { OTLink fLink; char* fPortName; char* fModuleName; char* fResourceInfo; char* fSlotID; struct TPortRecord* fAlias; size_t fNumChildren; OTPortRef* fChildPorts; UInt32 fPortFlags; UInt32 fInfoFlags; UInt32 fCapabilities; OTPortRef fRef; struct streamtab* fStreamtab; void* fContext; void* fExtra; }; /******************************************************************************* ** "C" Interface routines ********************************************************************************/ #ifdef __cplusplus extern "C" { #endif /* ------------------------------------------------------------------------- Interrupt control functions ------------------------------------------------------------------------- */ #if USES68KINLINES // // MPS_INTR_STATE saves the current interrupt state // Its definition undoubtably changes with the definition // of mps intr enable/disable, so this typedef is // also inside the USE68KINLINES conditional. // typedef UInt8 MPS_INTR_STATE; // // Disable interrupts and save the state // #pragma parameter mps_intr_disable(__A0) void mps_intr_disable(MPS_INTR_STATE*) = { 0x40C0, /* move sr,d0 */ 0xE040, /* asr.w #8,d0 */ 0x007C, 0x0600, /* ori #$600,sr */ 0x027C, 0xFEFF, /* andi #$FEFF,sr */ 0x1080 /* move.b d0,(a0) */ #if qDebug > 1 , 0x0200, 0x0070, /* andi.b #$70,d0 */ 0x0c00, 0x0070, /* cmpi.b #$70,d0 */ 0x6602, /* bne.s @3 */ 0xA9FF /* DebugBreak */ #endif }; // // Enable interrupts from the saved state // #pragma parameter mps_intr_enable(__A0) void mps_intr_enable(MPS_INTR_STATE* ptr) = { #if qDebug > 1 0x40C0, /* move sr,d0 */ 0x0240, 0x0700, /* andi.w #$700,d0 */ 0x0C40, 0x0600, /* cmpi.w #$600,d0 */ 0x6702, /* beq.s @2 */ 0xA9FF, /* DebugBreak */ #endif 0x1010, /* @2 move.b (a0),d0 */ #if qDebug > 1 0x0200, 0x0070, /* andi.b #$70,d0 */ 0x0c00, 0x0070, /* cmpi.b #$70,d0 */ 0x6602, /* bne.s @3 */ 0xA9FF, /* DebugBreak */ 0x1010, /* @3 move.b (a0),d0 */ #endif 0xE140, /* asl.w #8,d0 */ 0x46C0 /* move d0,sr */ }; #else #if TRADMACOS typedef UInt8 MPS_INTR_STATE; #else typedef void* MPS_INTR_STATE; #endif void mps_intr_disable(MPS_INTR_STATE*); void mps_intr_enable(MPS_INTR_STATE*); #endif /* ------------------------------------------------------------------------- The kOTPortScannerInterfaceID define is what you need to add to your export file for the "interfaceID = " clause. PortScanProcPtr is the typedef for the scanning function. Your port-scanning function must be exported by the name "OTScanPorts". Your port-scanning function set must use the prefix kOTPortScannerPrefix. ------------------------------------------------------------------------- */ #define kOTPortScannerInterfaceID kOTKernelPrefix "pScnr,1.0" #define kOTPseudoPortScannerInterfaceID kOTKernelPrefix "ppScnr,1.0" typedef void (* _CDECL PortScanProcPtr)(UInt32 scanType); enum /* scanType */ { kOTInitialScan = 0, kOTScanAfterSleep = 1 }; /* ------------------------------------------------------------------------- Port Registration These routines can be used to register, find and iterate through the various ports on the machine ------------------------------------------------------------------------- */ // // Register a port. The name the port was registered under is returned in // the fPortName field. // OSStatus OTRegisterPort(OTPortRecord* portInfo, void* ref); // // Unregister the port with the given name (If you re-register the // port, it may get a different name - use OTChangePortState if // that is not desireable). Since a single OTPortRef can be registered // with several names, the API needs to use the portName rather than // the OTPortRef to disambiguate. // OSStatus OTUnregisterPort(const char* portName, void**); // // Change the status of the port. // void OTChangePortState(OTPortRef ref, UInt32 theChange, OSStatus why); // // Find the TPortRecord for a given Port Name // TPortRecord* OTFindPort(const char* portName); // // Find the "nth" TPortRecord // TPortRecord* OTGetIndexedPort(size_t index); // // Find another port that is active and conflicts with // the port described by "ref" // TPortRecord* OTFindPortConflict(OTPortRef ref); // // Other ways of finding the port // TPortRecord* OTFindPortByRef(OTPortRef); TPortRecord* OTFindPortByDev(dev_t); /* ------------------------------------------------------------------------- Timer functions ------------------------------------------------------------------------- */ mblk_t* mi_timer_q_switch(mblk_t*, queue_t*, mblk_t*); Boolean mi_timer_cancel(mblk_t*); void mi_timer(mblk_t*, unsigned long); mblk_t* mi_timer_alloc(queue_t*, size_t); void mi_timer_free(mblk_t*); Boolean mi_timer_valid(mblk_t*); /* ------------------------------------------------------------------------- Miscellaneous helpful routines ------------------------------------------------------------------------- */ /* * This is the typedef for a function that will be called when a message * created by OTAllocMsg is destroyed. */ typedef void (* _CDECL EsbFreeProcPtr)(char* arg); /* * This function creates a message which points to "size" bytes of data * at "buf". When the message is freed, the EsbFreeProcPtr function "func" * will be called with the argument "arg". * NOTE: This function allows users of your buffer to modify the buffer. */ mblk_t* OTAllocMsg(void* buf, size_t size, EsbFreeProcPtr func, void* arg); /* * Routines to allocate and free memory in your modules (these are * interrupt-time safe!). */ void* OTAllocMem(size_t); void OTFreeMem(void*); void* OTReallocMem(void* ptr, size_t newSize); void* OTAllocPortMem(size_t); void OTFreePortMem(void*); /* * Routines to calculate various sizes of STREAM messages */ #define HEAD_SIZE(mp) ((mp)->b_rptr - (mp)->b_datap->db_base) #define TAIL_SIZE(mp) ((mp)->b_datap->db_lim - (mp)->b_wptr) #define MBLK_SIZE(mp) ((mp)->b_wptr - (mp)->b_rptr) #define DBLK_SIZE(mp) ((mp)->b_datap->db_lim - (mp)->b_datap->db_base) #ifdef __cplusplus extern "C" { #endif int mi_bcmp(const char* first, const char* second, size_t nBytes); int mi_sprintf (char * buf, char * fmt, ...); #ifdef __cplusplus } #endif #define bcopy(s, d, l) OTMemcpy(d, s, l) #define bzero(d, l) OTMemzero(d, (size_t)(l)) #define bcmp(s, d, l) mi_bcmp(s, d, l) /* * Standard STREAMS bcopy, bzero, & bcmp take char* parameters. * The BCOPY, BZERO, and BCMP routines take void* so that we do not have * to cast all the pointers. */ #define BCOPY(s, d, l) bcopy((const char*)(s), (char*)(d), l) #define BZERO(d, l) bzero((char*)(d), l) #define BCMP(s, d, l) mi_bcmp((const char*)(s), (const char*)(d), l) /* * Create sprintf and printf functions that will work in STREAM modules. * Also, make sure that calling traditional "C" allocation routines * will not compile. */ #define sprintf mi_sprintf #define printf OTKernelPrintf #define calloc (DONT_CALL*THIS_FUNCTION) #define malloc (DONT_CALL*THIS_FUNCTION) #define realloc (DONT_CALL*THIS_FUNCTION) #define free (DONT_CALL*THIS_FUNCTION) /* * A few other miscellaneous functions */ int drv_priv(struct cred* credp); queue_t* mi_allocq(struct streamtab*); mblk_t* mi_reallocb(mblk_t*, size_t new_Size); #ifdef __cplusplus } /******************************************************************************* ** Everything below here is C++ ONLY ********************************************************************************/ /* ------------------------------------------------------------------------- TStreamQueue class This class is just a convenient interface to the queue structure ------------------------------------------------------------------------- */ class TStreamQueue : public queue { public: void EnableQueue(); }; /* ------------------------------------------------------------------------- Inline methods for TStreamQueue ------------------------------------------------------------------------- */ inline void TStreamQueue::EnableQueue() { if ( q_flag & QNOENB ) { enableok(this); if ( q_first ) qenable(this); } } /* ------------------------------------------------------------------------- Class TStreamMessage This class is a C++ interface to the mblk_t structure defined in STREAMS ------------------------------------------------------------------------- */ // // The maximum stream buffer size is the largest "size_t" that // doesn't look negative if interpreted as a signed number // enum { kMaxStreamBufferSize = (((size_t)-1L) >> 1) }; #if GENERATINGPOWERPC #pragma options align=mac68k #endif class TStreamMessage : public msgb { private: void* operator new (size_t) { return NULL; } public: void* operator new(size_t, size_t size) { return (TStreamMessage*)allocb(size, 0); } void* operator new(size_t, void* buf, size_t size, EsbFreeProcPtr func, void* arg) { return OTAllocMsg(buf, size, func, arg); } void operator delete(void* ptr) { freemsg((mblk_t*)ptr); } void Reset(size_t = 0); void ResetWithLeader(size_t); void SetStartWithLeader(size_t); void FreeData(); TStreamMessage* RemoveData(); void AppendData(TStreamMessage* data); size_t GetSize() const; size_t GetDataSize() const; size_t GetMessageDataSize() const; void SetDataSize(size_t); void SetType(UInt8); UInt8 GetType() const; TStreamMessage* GetNextBlock() const; void SetNextBlock(TStreamMessage*); char* GetDataPointer() const; Boolean IsReuseable(size_t size) const; void HideBytesAtFront(size_t); void HideBytesAtEnd(size_t); // // The following functions ignore non-M_DATA blocks. // const TStreamMessage* _MDECL GetBlockAt(size_t& offset) const; const void* _MDECL GetPointerTo(size_t offset, size_t* len) const; const void* _MDECL GetPointerTo(size_t offset, size_t* len, void* bfr) const; // // This function makes a non-shared copy of any initial non-M_DATA block, and // then makes shared copies of the requested data. It only assumes 1 leading // non-M_DATA block, but will skip any other non-M_DATA blocks while // searching for data to copy. // TStreamMessage* _MDECL MakeSharedCopy(size_t offset = 0, size_t len = kMaxStreamBufferSize); Boolean _MDECL HasData() const; Boolean _MDECL WriteData(void* buf, size_t len); // // These hide/remove the part of the data already read. // TStreamMessage* _MDECL ReadData(void* buf, size_t* len); size_t _MDECL ReadControl(void* buf, size_t len); }; #if GENERATINGPOWERPC #pragma options align=reset #endif /* ------------------------------------------------------------------------- Inline methods for TStreamMessage ------------------------------------------------------------------------- */ inline void TStreamMessage::Reset(size_t size) { b_rptr = b_datap->db_base; b_wptr = b_rptr + size; } inline void TStreamMessage::ResetWithLeader(size_t size) { b_wptr = b_datap->db_lim; b_rptr = b_wptr - size; } inline void TStreamMessage::SetStartWithLeader(size_t size) { b_rptr = b_datap->db_lim - size; } inline void TStreamMessage::FreeData() { if ( b_cont ) { freemsg(b_cont); b_cont = NULL; } } inline TStreamMessage* TStreamMessage::RemoveData() { TStreamMessage* temp = (TStreamMessage*)b_cont; b_cont = NULL; return temp; } inline void TStreamMessage::AppendData(TStreamMessage* mp) { linkb(this, mp); } inline size_t TStreamMessage::GetSize() const { return b_datap->db_lim - b_datap->db_base; } inline size_t TStreamMessage::GetDataSize() const { return b_wptr - b_rptr; } inline size_t TStreamMessage::GetMessageDataSize() const { return msgdsize(this); } inline void TStreamMessage::SetDataSize(size_t size) { b_wptr = b_rptr + size; } inline void TStreamMessage::SetType(UInt8 type) { b_datap->db_type = type; } inline unsigned char TStreamMessage::GetType() const { return b_datap->db_type; } inline TStreamMessage* TStreamMessage::GetNextBlock() const { return (TStreamMessage*)b_cont; } inline void TStreamMessage::SetNextBlock(TStreamMessage* mp) { b_cont = (mblk_t*)mp; } inline char* TStreamMessage::GetDataPointer() const { return (char*)b_rptr; } inline Boolean TStreamMessage::IsReuseable(size_t size) const { return (b_datap->db_ref == 1 && GetSize() >= size); } inline void TStreamMessage::HideBytesAtFront(size_t len) { adjmsg(this, len); } inline void TStreamMessage::HideBytesAtEnd(size_t len) { adjmsg(this, -len); } /* ------------------------------------------------------------------------- TTimerMessage class This class implements an interface to the STREAM environment timer facilities. A TTimerMessage will be placed on the queue of your choice when it's timer expires. ------------------------------------------------------------------------- */ #if GENERATINGPOWERPC #pragma options align=mac68k #endif #if GENERATINGPOWERPC #define TIMER_BUG 1 #else #define TIMER_BUG 0 #endif class TTimerMessage : public TStreamMessage { #if TIMER_BUG private: #else public: #endif inline void* operator new(size_t, queue_t* q) { return mi_timer_alloc(q, sizeof(T_stream_timer)); } inline void* operator new(size_t, queue_t* q, size_t extra) { return mi_timer_alloc(q, extra + sizeof(T_stream_timer)); } inline void operator delete(void* ptr) { mi_timer_free((mblk_t*)ptr); } public: Boolean IsValid(); TTimerMessage* ChangeQueue(TStreamQueue* newQ, TTimerMessage* newMP); Boolean Cancel(); void Schedule(OTTimeout time); private: inline void* operator new(size_t) { return 0; } }; inline TTimerMessage* NewTimerMsg(queue_t* q, size_t extra = 0) { return (TTimerMessage*)mi_timer_alloc(q, sizeof(T_stream_timer) + extra); } inline void FreeTimerMsg(TTimerMessage* msg) { mi_timer_free(msg); } #if GENERATINGPOWERPC #pragma options align=reset #endif /* ------------------------------------------------------------------------- Inline methods for TStreamTimer ------------------------------------------------------------------------- */ inline Boolean TTimerMessage::IsValid() { return mi_timer_valid(this); } inline TTimerMessage* TTimerMessage::ChangeQueue(TStreamQueue* q, TTimerMessage* newMP) { return( (TTimerMessage*) mi_timer_q_switch(this, q, newMP)); } inline Boolean TTimerMessage::Cancel() { return mi_timer_cancel(this); } inline void TTimerMessage::Schedule(OTTimeout time) { ((T_stream_timer*)b_rptr)->PRIM_type = T_TIMER_REQ; mi_timer(this, (unsigned long)time); } #endif /* __cplusplus */ #if defined(__MWERKS__) && GENERATING68K #pragma pointers_in_A0 #endif #endif /* __OPENTPTMODULE__ */